Foxit PDF RDK
FoxitRDKNative Namespace Reference

Classes

class  Action
 
class  ActionCallback
 
class  AdditionalAction
 
class  Annot
 
class  AnnotArray
 
class  AnnotationSummary
 
class  AnnotationSummaryCallback
 
class  AnnotationSummarySettings
 
class  AppProviderCallback
 
class  AssociatedFiles
 
class  AsyncReaderCallback
 
class  Attachments
 
class  Barcode
 
class  Bitmap
 
class  Bookmark
 
class  BorderInfo
 
class  ButtonItem
 
class  CacheOption
 
class  CalcPageContentTask
 Represents a task for calculating the content of a specific page in a PDF document. More...
 
class  CalcPageContentTaskCallBack
 Defines a callback interface for handling the result of a CalcPageContentTask. More...
 
class  CalculateMaxSizeCallback
 Defines a callback interface for handling the result of a CalculateMaxSizeTask. More...
 
class  CalculateMaxSizeTask
 Represents a task for calculating the maximum size within a specified range. More...
 
class  Caret
 
class  CertificateEncryptData
 
class  CertificateSecurityCallback
 
class  CertificateSecurityHandler
 
class  CertIssuerPair
 
class  CertVerifyResult
 
class  CertVerifyResultArray
 
class  ChoiceOption
 
class  ChoiceOptionArray
 
class  Circle
 
class  ClearCacheTask
 Represents a task for clearing the cache. More...
 
class  ClearCacheTaskCallBack
 Defines a callback interface for handling the result of a ClearCacheTask. More...
 
class  CloseDocumentTask
 Represents a task for closing a PDF document. More...
 
class  CloseDocumentTaskCallBack
 Defines a callback interface for handling the result of a CloseDocumentTask. More...
 
class  Codec
 
class  Color
 
class  ColorSpace
 
class  ColorState
 
class  Combination
 
class  CombineDocumentInfo
 
class  CombineDocumentInfoArray
 
class  CompareResultInfo
 
class  CompareResultInfoArray
 
class  CompareResults
 
class  Comparison
 
class  ComplianceEngine
 
class  Control
 
class  Convert
 
class  CropPageSizeTask
 Represents a task for cropping the page size of a document. More...
 
class  CropPageSizeTaskCallBack
 Defines a callback interface for handling the result of a CropPageSizeTask. More...
 
class  CustomEncryptData
 
class  CustomSecurityCallback
 
class  CustomSecurityHandler
 
class  DateTime
 
class  DefaultAppearance
 
class  Destination
 
class  DialogDescriptionConfig
 
class  DialogDescriptionElement
 
class  DialogDescriptionElementArray
 
class  DocEventCallback
 
class  DocProviderCallback
 
class  DocumentsSource
 
class  DocViewerPrefs
 
class  DrawPageTask
 Represents a task for drawing a page in a document with various settings. More...
 
class  DrawPageTaskCallBack
 Defines a callback interface for handling the result of a DrawPageTask. More...
 
class  DrawPageTaskSettingData
 Represents the settings data for drawing a page in a document. More...
 
class  DRMEncryptData
 
class  DRMSecurityCallback
 
class  DRMSecurityHandler
 
class  DWG2PDFSettingData
 
class  EditCommentsTask
 EditCommentsTask class is used to handle various events related to edit comments, such as import or export comments.. More...
 
class  EditCommentsTaskCallBack
 Defines a callback interface for handling results of a EditCommentsTaskCallBack. More...
 
class  EditFormTask
 EditFormTask class is used to handle various events related to forms, such as reset, import, and export. More...
 
class  EditFormTaskCallBack
 Defines a callback interface for handling results of a EditFormTaskCallBack. More...
 
class  EmbeddedFontData
 
class  EmbeddedGotoAction
 
class  EmbeddedGotoTarget
 
class  Excel2PDFSettingData
 
class  FDFDoc
 
class  Field
 
class  FieldArray
 
class  FileAttachment
 
class  FileReaderCallback
 
class  FileSpec
 
class  FileWriterCallback
 
class  Filler
 
class  FillerAssistCallback
 
class  FillSign
 
class  FillSignObject
 
class  FixupData
 
class  FloatArray
 
class  FloatingInfo
 
class  Font
 
class  FontMapperCallback
 
class  FontMapResult
 
class  Form
 
class  FormCombination
 
class  FormFileInfo
 
class  FormFileInfoArray
 
class  FormXObject
 
class  FreeText
 
class  FSFloatFArray
 An array of float values. More...
 
class  FullTextSearch
 
class  GotoAction
 
class  GraphicsObject
 
class  GraphicsObjectArray
 
class  GraphicsObjects
 
class  GraphState
 
class  HeaderFooter
 
class  HeaderFooterContent
 
class  HeaderFooterContentGenerator
 
class  HideAction
 
class  Highlight
 
class  HitData
 
class  HTML2PDFRelatedResource
 
class  HTML2PDFRelatedResourceArray
 
class  HTML2PDFSettingData
 
class  IconFit
 
class  IconProviderCallback
 
class  IdentityProperties
 
class  Image
 
class  ImageObject
 
class  ImageSettings
 
class  ImportDataAction
 
class  Ink
 
class  Int32Array
 
class  JavaScriptAction
 
class  JoinSplit
 
class  LaunchAction
 
class  LayerContext
 
class  LayerNode
 
class  LayerNodeArray
 
class  LayerPrintData
 
class  LayerTree
 
class  LayerZoomData
 
class  Library
 
class  Line
 
class  Link
 
class  LRContentElement
 
class  LRContext
 
class  LRElement
 
class  LRGraphicsObjectElement
 
class  LRStructureElement
 
class  LTVVerifier
 
class  MarkedContent
 
class  Markup
 
class  MarkupArray
 
class  Matrix2D
 
class  MediaPlayer
 
class  MediaPlayerCallback
 
class  MediaSettings
 
class  MenuItemConfig
 
class  MenuItemEx
 
class  MenuItemExArray
 
class  MenuList
 
class  MenuListArray
 
class  Metadata
 
class  MonoImageSettings
 
class  NamedAction
 
class  Note
 
class  NoteArray
 
class  NotifierCallback
 
class  OCR
 
class  OCREngine
 
class  OCRSettingData
 
class  OCRSettingDataArray
 
class  OCRSuspectInfo
 
class  OCRSuspectInfoArray
 
class  OFDConvertParam
 
class  OFDDoc
 
class  OFDPage
 
class  OFDRenderer
 
class  OpenDocumentSettingData
 Represents the settings data for opening a document. More...
 
class  OpenDocumentTask
 Represents a task for opening a document with specified settings and options. More...
 
class  OpenDocumentTaskCallBack
 Defines a callback interface for handling the result of an OpenDocumentTask. More...
 
class  Optimizer
 
class  OptimizerSettings
 
class  OutputPreview
 
class  PageBasicInfo
 
class  PageLabels
 
class  PageNumberRange
 
class  PageSizeTask
 Represents a task for setting page sizes within a document. More...
 
class  PageSizeTaskCallBack
 Defines a callback interface for handling results of a PageSizeTask. More...
 
class  PageSizeTaskSettingData
 Represents the settings data for a page size task. More...
 
class  PageTextLinks
 
class  PagingSeal
 
class  PagingSealConfig
 
class  PagingSealSignature
 
class  ParagraphEditing
 
class  ParagraphEditingUndoItem
 
class  Path
 
class  PathArray
 
class  PathObject
 
class  PauseCallback
 
class  PayLoadData
 
class  PDFArray
 
class  PDFDictionary
 
class  PDFDoc
 
class  PDFNameTree
 
class  PDFNumberTree
 
class  PDFObject
 
class  PDFPage
 
class  PDFStream
 
class  PDFStructTree
 
class  PlayerArgs
 
class  Point
 
class  PointF
 
class  PointFArray
 
class  Polygon
 
class  PolyLine
 
class  Popup
 
class  Portfolio
 
class  PortfolioFileNode
 
class  PortfolioFolderNode
 
class  PortfolioNode
 
class  PortfolioNodeArray
 
class  PowerPoint2PDFSettingData
 
class  PrintParams
 
class  Progressive
 
class  PSI
 
class  PSICallback
 
class  PSInk
 
class  QuadPoints
 
class  QuadPointsArray
 
class  Range
 
class  ReadingBookmark
 
class  RectF
 
class  RectFArray
 An array of RectF objects. More...
 
class  RectI
 
class  Redact
 
class  Redaction
 
class  ReflowPage
 
class  RemoteGotoAction
 
class  RenderConfig
 
class  Renderer
 
class  Rendition
 
class  RenditionAction
 
class  ResetFormAction
 
class  Response
 
class  ResultInformation
 
class  RevocationArrayInfo
 
class  RevocationCallback
 
class  RichTextStyle
 
class  RMSEncryptData
 
class  RMSSecurityCallback
 
class  RMSSecurityHandler
 
class  SaveDocTask
 Represents a task for saving a PDF document to a specified file path. More...
 
class  SaveDocTaskCallBack
 Defines a callback interface for handling the result of a SaveDocTask. More...
 
class  SchemaField
 
class  SchemaFieldArray
 
class  Screen
 
class  SearchCallback
 
class  SearchCancelCallback
 
class  SearchIndexConfig
 
class  SearchOption
 
class  SearchPageInfo
 
class  SearchPageTask
 Represents a task for search page content within a document. More...
 
class  SearchPageTaskCallBack
 Defines a callback interface for handling results of a SearchPageTaskCallBack. More...
 
class  SearchResult
 
class  SearchResultArray
 An array of SearchResult objects. More...
 
class  SecurityCallback
 
class  SecurityHandler
 
class  ShadingColor
 
class  ShadingObject
 
class  Signature
 
class  SignatureArray
 
class  SignatureCallback
 
class  SignatureFillSignObject
 
class  SignatureVerifyResult
 
class  SignatureVerifyResultArray
 
class  SnappedPoint
 
class  SnapPointMgr
 
class  SOAPAuthenticateInfo
 
class  SOAPRequestProperties
 
class  SOAPResponseInfo
 
class  Sound
 
class  Square
 
class  Squiggly
 
class  Stamp
 
class  StdEncryptData
 
class  StdSecurityHandler
 
class  StreamCallback
 File stream interface, reading & writing. More...
 
class  StrikeOut
 
class  StringArray
 
class  StructElement
 
class  StructMarkedContent
 
class  StructObjectContent
 
class  StructTreeEntity
 
class  SubmitFormAction
 
class  TableBorderInfo
 
class  TableCellData
 
class  TableCellDataArray
 
class  TableCellDataColArray
 This class represents an array of TableCellData objects,inserted in the order of the displayed table from left to right. More...
 
class  TableCellIndexArray
 An array of table cell index. More...
 
class  TableData
 
class  TableOfContentsConfig
 
class  TabOrderMgr
 
class  Task
 Represents a task with various states and operations. More...
 
class  TaskServer
 
class  TextFillSignObject
 
class  TextFillSignObjectData
 
class  TextFillSignObjectDataArray
 
class  TextLink
 
class  TextMarkup
 
class  TextObject
 
class  TextPage
 
class  TextPageCharInfo
 
class  TextSearch
 
class  TextState
 
class  TiledWatermarkSettings
 
class  TimeRange
 
class  TimerCallback
 
class  TimeStampCallback
 
class  TimeStampServer
 
class  TimeStampServerMgr
 
class  TrustedCertStoreCallback
 
class  TXT2PDFSettingData
 
class  UInt32Array
 
class  Underline
 
class  UnembeddedFontSettings
 
class  URIAction
 
class  UrlFileRead
 
class  UrlHeader
 
class  ViewStatus
 Represents the status of a view in a document or application. More...
 
class  Watermark
 
class  WatermarkSettings
 
class  WatermarkTextProperties
 
class  Widget
 
class  WidgetChoiceOption
 
class  WidgetChoiceOptionArray
 
class  WidgetMenu
 
class  Word2PDFSettingData
 
class  WrapperData
 
class  WStringArray
 
class  XFADoc
 
class  XFAPage
 
class  XFAWidget
 

Enumerations

enum  EditCommentsType { IMPORT_COMMENTS, EXPORT_COMMENTS, EXPORT_HIGHLIGHT_TEXT }
 
enum  EditFormType { RESET_FORM, IMPORT_FORM, EXPORT_FORM }
 
enum  ErrorCode {
  e_ErrSuccess, e_ErrFile, e_ErrFormat, e_ErrPassword,
  e_ErrHandle, e_ErrCertificate, e_ErrUnknown, e_ErrInvalidLicense,
  e_ErrParam, e_ErrUnsupported, e_ErrOutOfMemory, e_ErrSecurityHandler,
  e_ErrNotParsed, e_ErrNotFound, e_ErrInvalidType, e_ErrConflict,
  e_ErrUnknownState, e_ErrDataNotReady, e_ErrInvalidData, e_ErrXFALoadError,
  e_ErrNotLoaded, e_ErrInvalidState, e_ErrNotCDRM, e_ErrCanNotConnectToServer,
  e_ErrInvalidUserToken, e_ErrNoRights, e_ErrRightsExpired, e_ErrDeviceLimitation,
  e_ErrCanNotRemoveSecurityFromServer, e_ErrCanNotGetACL, e_ErrCanNotSetACL, e_ErrIsAlreadyCPDF,
  e_ErrIsAlreadyCDRM, e_ErrCanNotUploadDocInfo, e_ErrCanNotUploadCDRMInfo, e_ErrInvalidWrapper,
  e_ErrCanNotGetClientID, e_ErrCanNotGetUserToken, e_ErrInvalidACL, e_ErrInvalidClientID,
  e_ErrOCREngineNotInit, e_ErrDiskFull, e_ErrOCRTrialIsEnd, e_ErrFilePathNotExist,
  e_ErrComplianceEngineNotInit, e_ErrComplianceEngineInvalidUnlockCode, e_ErrComplianceEngineInitFailed, e_ErrTimeStampServerMgrNotInit,
  e_ErrLTVVerifyModeNotSet, e_ErrLTVRevocationCallbackNotSet, e_ErrLTVCannotSwitchVersion, e_ErrLTVCannotCheckDTS,
  e_ErrLTVCannotLoadDSS, e_ErrLTVCannotLoadDTS, e_ErrNeedSigned, e_ErrComplianceResourceFile,
  e_ErrTimeStampServerMgrNoDefaltServer, e_ErrDefaultTimeStampServer, e_ErrNoConnectedPDFModuleRight, e_ErrNoXFAModuleRight,
  e_ErrNoRedactionModuleRight, e_ErrNoRMSModuleRight, e_ErrNoOCRModuleRight, e_ErrNoComparisonModuleRight,
  e_ErrNoComplianceModuleRight, e_ErrNoOptimizerModuleRight, e_ErrNoConversionModuleRight, e_ErrOfficeComNotInit,
  e_ErrNoMicroOfficeInstalled, e_ErrExcelHasNoContent, e_ErrNoLayoutRecognitionModuleRight, e_ErrWPSEngineNotFound,
  e_ErrLibreofficeEngineNotFound, e_ErrNoAccessibilityModuleRight, e_ErrODAEngineNotFound, e_ErrNoTableMakerModuleRight,
  e_ErrNoDWG2PDFModuleRight, e_ErrNoAdvEditModuleRight, e_ErrNoPDF2OfficeModuleRight, e_ErrURLInBlackList,
  e_ErrNoDocumentPermission, e_ErrOFDEngineNotInit
}
 

Functions

function export AsyncRenderPage (cb(state);, doc, render, page, matrix, pause)
 

Variables

const e_AlignmentCenter
 Center alignment.
 
const e_AlignmentLeft
 Enumeration for alignment (horizontal). More...
 
const e_AlignmentRight
 Right alignment.
 
const e_ColorSpaceCalGray
 Color space: CalGray. (1 component, A)
 
const e_ColorSpaceCalRGB
 Color space: CalRGB. (3 components, A, B, C)
 
const e_ColorSpaceDeviceCMYK
 Color space: DeviceCMYK. (4 components, C, M, Y, K)
 
const e_ColorSpaceDeviceGray
 Color space: DeviceGray. (1 component, gray)
 
const e_ColorSpaceDeviceN
 Color space: DeviceN.
 
const e_ColorSpaceDeviceRGB
 Color space: DeviceRGB. (3 components, R, G, B)
 
const e_ColorSpaceICCBasedDeviceCMYK
 Color space: ICCBased DeviceCMYK. (4 components, C, M, Y, K)
 
const e_ColorSpaceICCBasedDeviceGray
 Color space: ICCBased DeviceGray. (1 component, gray)
 
const e_ColorSpaceICCBasedDeviceRGB
 Color space: ICCBased DeviceRGB. (3 components, R, G, B)
 
const e_ColorSpaceInvalid
 Enumeration for color space. More...
 
const e_ColorSpaceLab
 Color space: Lab. (3 components, A, B, C)
 
const e_ColorSpacePattern
 Color space: Pattern.
 
const e_ColorSpaceSeparation
 Color space: Separation.
 
const e_FileFormatTypeFDF
 Enumeration for file format type. More...
 
const e_FileFormatTypeHTML
 File format type: HTML.
 
const e_FileFormatTypePDF
 File format type: PDF.
 
const e_FileFormatTypeTXT
 File format type: TXT.
 
const e_FileFormatTypeXDP
 File format type: XDP.
 
const e_FileFormatTypeXFD
 File format type: XFD.
 
const e_FileFormatTypeXFDF
 File format type: XFDF.
 
const e_FileFormatTypeXML
 File format type: XML.
 
const e_FillModeAlternate
 Alternate fill mode, in which the system fills this area between odd-numbered and even-numbered polygon sides on each scan line.
 
const e_FillModeNone
 Enumeration for filling mode type, mainly for path graphics object. More...
 
const e_FillModeWinding
 Winding fill mode, in which the system uses a direction in which a figure is drawn to determine whether to fill an area.
 
const e_LocaleIDFrance
 Locale ID for country: France.
 
const e_LocaleIDGermany
 Locale ID for country: Germany.
 
const e_LocaleIDHongKong
 Locale ID for region: HongKong.
 
const e_LocaleIDItaly
 Locale ID for country: Italy.
 
const e_LocaleIDJapan
 Locale ID for country: Japan.
 
const e_LocaleIDKorea
 Locale ID for country: Korea.
 
const e_LocaleIDNetherlands
 Locale ID for country: Netherlands.
 
const e_LocaleIDTaiwan
 Locale ID for region: Taiwan.
 
const e_LocaleIDUnspecified
 Enumeration for locale ID. More...
 
const e_ModuleNameAccessibility
 Name for module "Accessibility".
 
const e_ModuleNameAdvEdit
 Name for module "AdvEdit".
 
const e_ModuleNameComparison
 Name for module "Comparison".
 
const e_ModuleNameCompliance
 Name for module "Compliance".
 
const e_ModuleNameConnectedPDF
 Enumeration for module name which is used in license information. More...
 
const e_ModuleNameConversion
 Name for module "Conversion".
 
const e_ModuleNameDWG2PDF
 Name for module "DWG2PDF".
 
const e_ModuleNameLayoutRecognition
 (Reserved, currently, this module is not provided) Name for module "LayoutRecognition".
 
const e_ModuleNameOCR
 Name for module "OCR".
 
const e_ModuleNameOptimizer
 Name for module "Optimizer".
 
const e_ModuleNamePDF2Office
 Name for module "PDF2Office".
 
const e_ModuleNameRedaction
 Name for module "Redaction".
 
const e_ModuleNameRMS
 Name for module "RMS".
 
const e_ModuleNameTableMaker
 Name for module "TableMaker".
 
const e_ModuleNameXFA
 Name for module "XFA".
 
const e_PosBottomCenter
 Position: bottom center.
 
const e_PosBottomLeft
 Position: bottom left.
 
const e_PosBottomRight
 Position: bottom right.
 
const e_PosCenter
 Position: center.
 
const e_PosCenterLeft
 Position center left.
 
const e_PosCenterRight
 Position: center right.
 
const e_PosTopCenter
 Position: top center.
 
const e_PosTopLeft
 Enumeration for watermark position in a PDF page. More...
 
const e_PosTopRight
 Position: top right.
 
const e_Rotation0
 Enumeration for rotation. More...
 
const e_Rotation180
 Rotate 180 degrees in clockwise direction.
 
const e_Rotation270
 Rotate 270 degrees in clockwise direction.
 
const e_Rotation90
 Rotate 90 degrees in clockwise direction.
 
const e_RotationUnknown
 Unknown rotation.
 

Detailed Description

This namespace is used to encapsulate the types and functionality associated with Foxit RDK (Rapid Development Kit). Contains tools, interfaces, and enumerations for working with PDF documents.

Enumeration Type Documentation

◆ EditCommentsType

Edit operations for comments.

Enumerator
IMPORT_COMMENTS 

Reset form event.

EXPORT_COMMENTS 

Import form event.

EXPORT_HIGHLIGHT_TEXT 

Export form event.

◆ EditFormType

Edit operations for forms.

Enumerator
RESET_FORM 

Reset form event.

IMPORT_FORM 

Import form event.

EXPORT_FORM 

Export form event.

◆ ErrorCode

Enumerator
e_ErrSuccess 

Success, and no error occurs.

e_ErrFile 

File cannot be found or could not be opened.

e_ErrFormat 

Format is invalid. For files, this may also mean that file is corrupted.

e_ErrPassword 

Invalid password. Usually, this error may occur when loading a PDF document with password. When meet this, user should load document again with correct password.

e_ErrHandle 

Error handle.

e_ErrCertificate 

Certificate error: PDF document is encrypted by digital certificate but current user does not have the correct certificate.

e_ErrUnknown 

Any unknown error occurs.

e_ErrInvalidLicense 

Invalid license is used to initialize Foxit PDF SDK library.

e_ErrParam 

Parameter error: value of any input parameter for a function is invalid.

e_ErrUnsupported 

Some types are not supported.

e_ErrOutOfMemory 

Out-of-memory error occurs.

e_ErrSecurityHandler 

PDF document is encrypted by some unsupported security handler.

e_ErrNotParsed 

Content has not been parsed yet. Usually, this represents PDF page has not been parsed yet.

e_ErrNotFound 

Expected data or object is not found.

e_ErrInvalidType 

The type of input object or current object is invalid.

e_ErrConflict 

New data conflicts with existed data.

e_ErrUnknownState 

Any unknown state occurs.

e_ErrDataNotReady 

Data is not ready. Usually this is used as an exception error code when loading document in asynchronous way.

e_ErrInvalidData 

Data of current object is invalid.

e_ErrXFALoadError 

XFA loading error.

e_ErrNotLoaded 

Current object has not been loaded yet.

e_ErrInvalidState 

Invalid or incorrect state.

e_ErrNotCDRM 

(ForConnectedPDF only) The loaded document is not a ConnectedPDF DRM document.

e_ErrCanNotConnectToServer 

(ForConnectedPDF only) Cannot connect to ConnectedPDF server.

e_ErrInvalidUserToken 

(ForConnectedPDF only) Input user token is invalid.

e_ErrNoRights 

(ForConnectedPDF only) Current user has no right to open the ConnectedPDF DRM document.

e_ErrRightsExpired 

(ForConnectedPDF only) The rights of Current user has expired.

e_ErrDeviceLimitation 

(ForConnectedPDF only) Current device is limited to open the ConnectedPDF DRM document.

e_ErrCanNotRemoveSecurityFromServer 

(ForConnectedPDF only) Cannot remove the security from ConnectedPDF server.

e_ErrCanNotGetACL 

(For ConnectedPDF only) Cannot get the ACL from ConnectedPDF server.

e_ErrCanNotSetACL 

(For ConnectedPDF only) Cannot set the ACL to ConnectedPDF server.

e_ErrIsAlreadyCPDF 

(For ConnectedPDF only) Loaded document is already a ConnectedPDF document.

e_ErrIsAlreadyCDRM 

(For ConnectedPDF only) Loaded document is already a ConnectedPDF DRM document.

e_ErrCanNotUploadDocInfo 

(For ConnectedPDF only) Cannot upload ConnectedPDF document info to ConnectedPDF server.

e_ErrCanNotUploadCDRMInfo 

(For ConnectedPDF only) Cannot upload ConnectedPDF DRM document info to ConnectedPDF server.

e_ErrInvalidWrapper 

(For ConnectedPDF only) The input ConnectedPDF DRM wrapper document is invalid.

e_ErrCanNotGetClientID 

(For ConnectedPDF only) Cannot get client ID from ConnectedPDF server.

e_ErrCanNotGetUserToken 

(For ConnectedPDF only) Cannot get user token from ConnectedPDF server.

e_ErrInvalidACL 

(For ConnectedPDF only) Input ACL is invalid.

e_ErrInvalidClientID 

(For ConnectedPDF only) Input client ID is invalid.

e_ErrOCREngineNotInit 

(For OCR only) OCR engine has not been initialized successfully.

e_ErrDiskFull 

(For OCR only) Not enough disk space.

e_ErrOCRTrialIsEnd 

(For OCR only) The trial for OCR module is end.

e_ErrFilePathNotExist 

File or folder path does not exist.

e_ErrComplianceEngineNotInit 

(For compliance only) Compliance engine has not been initialized successfully.

e_ErrComplianceEngineInvalidUnlockCode 

(For compliance only) Invalid unlock code is used to initialize compliance engine.

e_ErrComplianceEngineInitFailed 

(For compliance only) Fail to initialize compliance engine.

e_ErrTimeStampServerMgrNotInit 

Time stamp server manager has not been initialized successfully.

e_ErrLTVVerifyModeNotSet 

(For LTV only) LTV verify mode has not been set.

e_ErrLTVRevocationCallbackNotSet 

(For LTV only) Revocation callback for LTV has not been set.

e_ErrLTVCannotSwitchVersion 

(For LTV only) Fail to switch PDF verion.

e_ErrLTVCannotCheckDTS 

(For LTV only) Fail to check DTS.

e_ErrLTVCannotLoadDSS 

(For LTV only) Fail to load DSS.

e_ErrLTVCannotLoadDTS 

(For LTV only) Fail to load DTS.

e_ErrNeedSigned 

(For signature only) The signature being operated needs to be signed.

e_ErrComplianceResourceFile 

(For compliance only) Compliance resource file(s) cannot be found or opened. Please check if compliance resource folder and files in this folder are valid.

e_ErrTimeStampServerMgrNoDefaltServer 

No default server has been set to time stamp server manager yet.

e_ErrDefaultTimeStampServer 

Cannot use current default time stamp server. Please check if default time stamp server can be used.

e_ErrNoConnectedPDFModuleRight 

No "ConnectedPDF" module right.

e_ErrNoXFAModuleRight 

No "XFA" module right.

e_ErrNoRedactionModuleRight 

No "Redaction" module right.

e_ErrNoRMSModuleRight 

No "RMS" module right.

e_ErrNoOCRModuleRight 

No "OCR" module right.

e_ErrNoComparisonModuleRight 

No "Comparison" module right.

e_ErrNoComplianceModuleRight 

No "Compliance" module right.

e_ErrNoOptimizerModuleRight 

No "Optimizer" module right.

e_ErrNoConversionModuleRight 

No "Conversion" module right.

e_ErrOfficeComNotInit 

(For Office-to-PDF conversion only) Office COM has not been initialized successfully.

e_ErrNoMicroOfficeInstalled 

(For Office-to-PDF conversion only) No Microsoft Office is installed in current system.

e_ErrExcelHasNoContent 

(For Excel-to-PDF conversion only) Excel document does not have any content so it cannot be converted to PDF file.

e_ErrNoLayoutRecognitionModuleRight 

No "LayoutRecognition" module right.

e_ErrWPSEngineNotFound 

(For Office-to-PDF conversion only) WPS office engine is not found.

e_ErrLibreofficeEngineNotFound 

(For Office-to-PDF conversion only) Libre office engine is not found.

e_ErrNoAccessibilityModuleRight 

No "Accessibility" module right.

e_ErrODAEngineNotFound 

(For DWG-to-PDF conversion only) ODA engine is not found.

e_ErrNoTableMakerModuleRight 

No "TableMaker" module right.

e_ErrNoDWG2PDFModuleRight 

No "DWG2PDF" module right.

e_ErrNoAdvEditModuleRight 

No "AdvEdit" module right.

e_ErrNoPDF2OfficeModuleRight 

No "PDF2Office" module right.

e_ErrURLInBlackList 

(For converting html to pdf only) The converted URL is on blacklist.

e_ErrNoDocumentPermission 

No document permission to operate.

e_ErrOFDEngineNotInit 

(For OFD only) OFD engine has not been initialized successfully.

Function Documentation

◆ AsyncRenderPage()

function export FoxitRDKNative.AsyncRenderPage ( cb(state);  ,
doc  ,
render  ,
page  ,
matrix  ,
pause   
)

Asynchronously renders a PDF page using the provided rendering options.

Parameters
{Function}cb - A callback function that is called with the rendering state. The state can indicate different stages or statuses of the rendering process.
{Renderer}render - The renderer instance used to perform the rendering of the PDF page.
{PDFPage}page - The PDF page object to be rendered.
{Matrix2D}matrix - A matrix defining the transformation to apply to the page during rendering. This can include operations like scaling, rotation, and translation.
{PauseCallback}pause - A callback that may be called to pause the rendering process. This can be used to temporarily halt rendering, for example, to wait for resources to load.
Returns
{void}

Variable Documentation

◆ e_AlignmentLeft

const FoxitRDKNative.e_AlignmentLeft

Enumeration for alignment (horizontal).

Values of this enumeration should be used alone.

Left alignment.

◆ e_ColorSpaceInvalid

const FoxitRDKNative.e_ColorSpaceInvalid

Enumeration for color space.

Values of this enumeration should be used alone.

Color space: Invalid.

◆ e_FileFormatTypeFDF

const FoxitRDKNative.e_FileFormatTypeFDF

Enumeration for file format type.

Values of this enumeration can be used alone.

File format type: FDF.

◆ e_FillModeNone

const FoxitRDKNative.e_FillModeNone

Enumeration for filling mode type, mainly for path graphics object.

Values of this enumeration should be used alone.

Fill mode: none.

◆ e_LocaleIDUnspecified

const FoxitRDKNative.e_LocaleIDUnspecified

Enumeration for locale ID.

Values of this enumeration can be used alone.

Locale ID: Unspecified, used when locale is not specified.

◆ e_ModuleNameConnectedPDF

const FoxitRDKNative.e_ModuleNameConnectedPDF

Enumeration for module name which is used in license information.

Values of this enumeration should be used alone.

(Reserved, currently, this module is not provided) Name for module "ConnectedPDF".

◆ e_PosTopLeft

const FoxitRDKNative.e_PosTopLeft

Enumeration for watermark position in a PDF page.

Values of this enumeration should be used alone.

Position: top left.

◆ e_Rotation0

const FoxitRDKNative.e_Rotation0

Enumeration for rotation.

Values of this enumeration should be used alone.

No rotation.